docs: add AGENTS.md contributor guide for AI agents#369
Open
ethanndickson wants to merge 3 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an
AGENTS.mdcontributor guide at the repo root to give AI coding agents the high-signal context they need to work in this provider safely.The document captures the provider's framework idioms (terraform-plugin-framework, not SDKv2), the resource file layout, essential
makecommands, and — most importantly — the project-specific patterns and anti-patterns distilled from past fixes (e.g. handling unknown values at plan/validate time, refreshing cached entitlements after a license apply, not stripping cty sensitivity marks in plan modifiers, and avoidingdeferinside retry loops). Each anti-pattern references the PR/issue it was learned from.Contents were verified against the current tree:
Makefiletargets, theutil.gohelpers,provider.goentitlement plumbing, the CI Terraform1.0–1.9acceptance matrix, and the golangciparalleltestconfig.